Oracle® Hospitality OPERA Web Self-Service
Housekeeping Web Service Specifications
Version 5.1
March 2022
Copyright © 2015, 2022, Oracle and/or its affiliates. All rights reserved.
This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.
If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable:
U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.
This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.
This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.
Contents
2 FetchHouseKeepingDiscrepancies
FetchHouseKeepingDiscrepanciesRequest
FetchHouseKeepingDiscrepenciesResponse
FetchHouseKeepingStatisticsRequest
FetchHouseKeepingStatisticsResponse
5 UpdateHouseKeepingDiscrepancies
UpdateHouseKeepingDiscrepanciesRequest
UpdateHouseKeepingDiscrepenciesResponse
6 Complex and Simple Type Definitions
ArrayOfHouseKeepingDiscrepancy
The objective of this document is to depict how the Housekeeping Web Service messages function in OPERA Web Suite (OWS). In addition, this document breaks-down the available simple and complex element types. This document may not contain all the web service messages supported by OWS.
This document is intended for those who are developing custom applications that interact with OPERA using Housekeeping messages functionality.
To contact Oracle Customer Support, access My Oracle Support at the following URL:
When contacting Customer Support, please provide the following:
· Product version and program/module name
· Functional and technical description of the problem (include business impact)
· Detailed step-by-step instructions to re-create
· Exact error message received and any associated log files
· Screen shots of each step you take
Oracle Hospitality product documentation is available on the Oracle Help Center at http://docs.oracle.com/en/industries/hospitality/
|
Date |
Version |
Description of Change |
|
December 2012 |
1.0 |
· Initial publication [V5.0.04.00]. |
|
February 2014 |
1.1 |
· Update all OEDS Documentation with proper example data - Housekeeping [V5.0.04.03]. |
|
September 2017 |
1.2 |
· Rebranded and updated the document format. |
|
March 2022 |
1.3 |
· Updated ArrayOfText, TextList, and ResultStatus. |
The following functions are currently provided through the Housekeeping
Web Service.
Allows for the inputting of
housekeeping information via web services.
|
Function |
Description |
|
FetchHouseKeepingDiscrepancies |
Displays the number of rooms where the status conflicts between Front Office and Housekeeping.
|
|
FetchHouseKeepingStatistics |
Displays the housekeeping information. |
|
FetchHouseStatus |
The House Status is a survey of all movements for the current date as well as any future date. Information available from this includes arrivals, departures, available rooms, housekeeping status, and expected occupancy for the date searched.
|
|
UpdateHouseKeepingDiscrepancies |
Updates the HouseKeeping Discrepancies with actual status. |
Displays the number of rooms where the status conflicts between Front Office and Housekeeping.
Soap Action: http://webservices.micros.com/ows/5.1/HouseKeeping.wsdl#FetchHouseKeepingDiscrepancies
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<OGHeader soap:mustUnderstand="1" transactionID="000099" timeStamp="2004-03-22T15:25:01.4625000-05:00" xmlns="http://webservices.micros.com/og/4.3/Core/">
<Origin entityID="WEST" systemType="WEB" />
<Destination entityID="WEST" systemType="PMS" />
<Authentication>
<UserCredentials>
<UserName>SAMPLEUSER</UserName>
<UserPassword>SAMPLEPASSWORD</UserPassword>
</UserCredentials>
</Authentication>
</OGHeader>
</soap:Header>
<soap:Body>
<FetchHouseKeepingDiscrepanciesRequest xmlns="http://webservices.micros.com/ows/5.1/HouseKeeping.wsdl">
<hotelReference hotelCode="SEPARA" />
<floor>
</floor>
<roomClass>
</roomClass>
<room>
</room>
<includeSleeps>Y</includeSleeps>
<includeSkips>Y</includeSkips>
<includePersonDiscrepancy>Y</includePersonDiscrepancy>
<includeDueOutOnly>
</includeDueOutOnly>
</FetchHouseKeepingDiscrepanciesRequest>
</soap:Body>
</soap:Envelope>
FetchHouseKeepingDiscrepanciesRequest
<xs:element name="FetchHouseKeepingDiscrepanciesRequest">
<xs:complexType>
<xs:annotation>
<xs:appinfo>
<keepNamespaceDeclarations>xsn</keepNamespaceDeclarations>
</xs:appinfo>
</xs:annotation>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="1" name="hotelReference" xmlns:q1="http://webservices.micros.com/og/4.3/HotelCommon/" type="q1:HotelReference" />
<xs:element minOccurs="0" maxOccurs="1" name="floor" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="roomClass" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="room" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="includeSleeps" type="xs:boolean" />
<xs:element minOccurs="0" maxOccurs="1" name="includeSkips" type="xs:boolean" />
<xs:element minOccurs="0" maxOccurs="1" name="includePersonDiscrepancy" type="xs:boolean" />
<xs:element minOccurs="0" maxOccurs="1" name="includeDueOutOnly" type="xs:boolean" />
</xs:sequence>
</xs:complexType>
</xs:element>
|
Name |
Type |
Data Type |
Use |
Comments |
|
hotelReference |
element |
HotelReference |
optional |
The Hotel Reference.
|
|
floor |
element |
string |
optional |
The floor in the Hotel.
|
|
roomClass |
element |
string |
optional |
The room class, which is a unique identifier for the type of room.
|
|
room |
element |
string |
optional |
The room number.
|
|
includeSleeps |
element |
boolean |
optional |
Define to include rooms in sleep status.
|
|
includeSkips |
element |
boolean |
optional |
Define to include rooms in skip status.
|
|
Name |
Type |
Data Type |
Use |
Comments |
|
includePersonDiscrepancy |
element |
boolean |
optional |
Define to include Guests in Discrepancy status.
|
|
includeDueOutOnly |
element |
boolean |
optional |
Define to include Due Out Reservations only. |
<?xml version="1.0"
encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<soap:Header>
<OGHeader soap:mustUnderstand="1" transactionID="000099" timeStamp="2004-03-22T16:25:01.4625-04:00" primaryLangID="E"
xmlns="http://webservices.micros.com/og/4.3/Core/">
<Origin entityID="WEST" systemType="PMS" />
<Destination entityID="WEST" systemType="WEB" />
<Authentication>
<UserCredentials>
<UserName>SAMPLEUSER</UserName>
<UserPassword>SAMPLEPASSWORD</UserPassword>
</UserCredentials>
</Authentication>
</OGHeader>
<wsa:Action>http://webservices.micros.com/ows/5.1/HouseKeeping.wsdl#FetchHouseKeepingDiscrepanciesResponse</wsa:Action>
<wsa:MessageID>urn:uuid:174b4eab-69a6-4601-92e3-6ebe7ee2380e</wsa:MessageID>
<wsa:RelatesTo>urn:uuid:7bb1f6a9-6d1b-4071-a001-0dec6612e578</wsa:RelatesTo>
<wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>
<wsse:Security>
<wsu:Timestamp wsu:Id="Timestamp-d0dd6ec6-6f87-426c-ab32-7ce8b0a2fc64">
<wsu:Created>2012-10-02T18:13:37Z</wsu:Created>
<wsu:Expires>2012-10-02T18:18:37Z</wsu:Expires>
</wsu:Timestamp>
</wsse:Security>
</soap:Header>
<soap:Body>
<FetchHouseKeepingDiscrepenciesResponse xmlns:hk="http://webservices.micros.com/og/4.3/HouseKeeping/" xmlns:c="http://webservices.micros.com/og/4.3/Common/" xmlns="http://webservices.micros.com/ows/5.1/HouseKeeping.wsdl">
<result resultStatusFlag="SUCCESS" />
<houseKeepingDiscrepancies>
<hk:HouseKeepingDiscrepancy>
<hk:roomNumber>0101</hk:roomNumber>
<hk:roomType>SEA</hk:roomType>
<hk:roomStatus>DIRTY</hk:roomStatus>
<hk:hKStatus>VACANT</hk:hKStatus>
<hk:fOStatus>VACANT</hk:fOStatus>
<hk:fOPersons>0</hk:fOPersons>
<hk:reservationStatus>NOTRESERVED</hk:reservationStatus>
<hk:hKPersons>4</hk:hKPersons>
<hk:discrepancy>Person</hk:discrepancy>
</hk:HouseKeepingDiscrepancy>
<hk:HouseKeepingDiscrepancy>
<hk:roomNumber>0110</hk:roomNumber>
<hk:roomType>SEA</hk:roomType>
<hk:roomStatus>DIRTY</hk:roomStatus>
<hk:hKStatus>OCCUPIED</hk:hKStatus>
<hk:fOStatus>VACANT</hk:fOStatus>
<hk:fOPersons>0</hk:fOPersons>
<hk:reservationStatus>NOTRESERVED</hk:reservationStatus>
<hk:hKPersons>4</hk:hKPersons>
<hk:discrepancy>Sleep / Person</hk:discrepancy>
</hk:HouseKeepingDiscrepancy>
</houseKeepingDiscrepancies>
</FetchHouseKeepingDiscrepenciesResponse>
</soap:Body>
</soap:Envelope>
FetchHouseKeepingDiscrepenciesResponse
<xs:element name="FetchHouseKeepingDiscrepenciesResponse">
<xs:complexType>
<xs:annotation>
<xs:appinfo>
<keepNamespaceDeclarations>xsn</keepNamespaceDeclarations>
</xs:appinfo>
</xs:annotation>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="1" name="result" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:ResultStatus" />
<xs:element minOccurs="0" maxOccurs="1" name="houseKeepingDiscrepancies" xmlns:q2="http://webservices.micros.com/og/4.3/HouseKeeping/" type="q2:ArrayOfHouseKeepingDiscrepancy" />
</xs:sequence>
</xs:complexType>
</xs:element>
|
Name |
Type |
Data Type |
Use |
Comments |
|
result |
element |
ResultStatus |
optional |
A primary indication of the success or failure of the called function.
|
|
houseKeepingDiscrepancies |
element |
ArrayOfHouseKeepingDiscrepancy |
optional |
Rooms that have a different housekeeping status then the front office status. |
Displays the housekeeping information.
Soap Action: http://webservices.micros.com/ows/5.1/HouseKeeping.wsdl#FetchHouseKeepingStatistics
<?xml
version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<OGHeader transactionID="000099" channelValidation="false" timeStamp="2008-02-20T09:34:22.9468750-05:00" xmlns="http://webservices.micros.com/og/4.3/Core/">
<Origin entityID="WEST" systemType="WEB" />
<Destination entityID="WEST" systemType="PMS" />
</OGHeader>
</soap:Header>
<soap:Body>
<FetchHouseKeepingStatisticsRequest xmlns="http://webservices.micros.com/ows/5.1/HouseKeeping.wsdl" xmlns:c="http://webservices.micros.com/og/4.3/Common/" xmlns:hc="http://webservices.micros.com/og/4.3/HotelCommon/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<HotelReference hotelCode="SEPARA" />
</FetchHouseKeepingStatisticsRequest>
</soap:Body>
</soap:Envelope>
FetchHouseKeepingStatisticsRequest
<xs:element name="FetchHouseKeepingStatisticsRequest">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="1" name="HotelReference" xmlns:q1="http://webservices.micros.com/og/4.3/HotelCommon/" type="q1:HotelReference" />
</xs:sequence>
</xs:complexType>
</xs:element>
|
Name |
Type |
Data Type |
Use |
Comments |
|
HotelReference |
element |
HotelReference |
optional |
The Hotel Reference. |
<?xml
version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<soap:Header>
<OGHeader transactionID="000099" timeStamp="2008-02-20T09:34:22.946875-05:00" primaryLangID="E"
xmlns="http://webservices.micros.com/og/4.3/Core/">
<Origin entityID="WEST" systemType="PMS" />
<Destination entityID="WEST" systemType="WEB" />
</OGHeader>
<wsa:Action>http://webservices.micros.com/ows/5.1/HouseKeeping.wsdl#FetchHouseKeepingStatisticsResponse</wsa:Action>
<wsa:MessageID>urn:uuid:957e1ec5-a5fb-4731-aa99-acb8d1b2e338</wsa:MessageID>
<wsa:RelatesTo>urn:uuid:1c1db15d-8161-4ec3-83aa-ed52f71d5f40</wsa:RelatesTo>
<wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>
<wsse:Security>
<wsu:Timestamp wsu:Id="Timestamp-bb452bf9-7a88-41e4-8445-de4461d681e5">
<wsu:Created>2012-07-12T18:38:41Z</wsu:Created>
<wsu:Expires>2012-07-12T18:43:41Z</wsu:Expires>
</wsu:Timestamp>
</wsse:Security>
</soap:Header>
<soap:Body>
<FetchHouseKeepingStatisticsResponse xmlns:hk="http://webservices.micros.com/og/4.3/HouseKeeping/" xmlns:c="http://webservices.micros.com/og/4.3/Common/" xmlns="http://webservices.micros.com/ows/5.1/HouseKeeping.wsdl">
<Result resultStatusFlag="SUCCESS" />
<HouseKeepingStatisticsList>
<hk:HouseKeepingStatistics description="TOTAL
ROOMS">155</hk:HouseKeepingStatistics>
<hk:HouseKeepingStatistics description="TOTAL
CLEAN">3</hk:HouseKeepingStatistics>
<hk:HouseKeepingStatistics description="TOTAL
DIRTY">16</hk:HouseKeepingStatistics>
<hk:HouseKeepingStatistics description="TOTAL
INSPECTED">135</hk:HouseKeepingStatistics>
<hk:HouseKeepingStatistics description="TOTAL
PICKUP">0</hk:HouseKeepingStatistics>
<hk:HouseKeepingStatistics description="TOTAL
OUT OF ORDER">0</hk:HouseKeepingStatistics>
<hk:HouseKeepingStatistics description="TOTAL
OUT OF SERVICE">1</hk:HouseKeepingStatistics>
<hk:HouseKeepingStatistics description="NOT
RESERVED - CLEAN">1</hk:HouseKeepingStatistics>
<hk:HouseKeepingStatistics description="NOT
RESERVED - DIRTY">14</hk:HouseKeepingStatistics>
<hk:HouseKeepingStatistics description="NOT
RESERVED - INSPECTED">127</hk:HouseKeepingStatistics>
<hk:HouseKeepingStatistics description="NOT
RESERVED - OUT OF SERVICE">1</hk:HouseKeepingStatistics>
<hk:HouseKeepingStatistics description="NOT
RESERVED - PICKUP">0</hk:HouseKeepingStatistics>
<hk:HouseKeepingStatistics description="RESERVED
- CLEAN">1</hk:HouseKeepingStatistics>
<hk:HouseKeepingStatistics description="RESERVED
- DIRTY">1</hk:HouseKeepingStatistics>
<hk:HouseKeepingStatistics description="RESERVED
- INSPECTED">8</hk:HouseKeepingStatistics>
<hk:HouseKeepingStatistics description="RESERVED
- OUT OF SERVICE">0</hk:HouseKeepingStatistics>
<hk:HouseKeepingStatistics description="RESERVED
- PICKUP">0</hk:HouseKeepingStatistics>
<hk:HouseKeepingStatistics description="TOTAL
QUEUE ROOMS">2</hk:HouseKeepingStatistics>
<hk:HouseKeepingStatistics description="STAYOVER">1</hk:HouseKeepingStatistics>
<hk:HouseKeepingStatistics description="ARRIVED">5</hk:HouseKeepingStatistics>
<hk:HouseKeepingStatistics description="DEPARTED">8</hk:HouseKeepingStatistics>
<hk:HouseKeepingStatistics description="PRE-ASSIGNED
ARRIVALS">3</hk:HouseKeepingStatistics>
<hk:HouseKeepingStatistics description="DAY
USE">1</hk:HouseKeepingStatistics>
<hk:HouseKeepingStatistics description="DUE
OUT">2</hk:HouseKeepingStatistics>
<hk:HouseKeepingStatistics description="NOT
RESERVED">135</hk:HouseKeepingStatistics>
<hk:HouseKeepingStatistics description="TOTAL
ARRIVALS">8</hk:HouseKeepingStatistics>
<hk:HouseKeepingStatistics description="TURNDOWN
REQUIRED">4</hk:HouseKeepingStatistics>
<hk:HouseKeepingStatistics description="TURNDOWN
NOT REQUIRED">2</hk:HouseKeepingStatistics>
<hk:HouseKeepingStatistics description="TURNDOWN
COMPLETED">3</hk:HouseKeepingStatistics>
</HouseKeepingStatisticsList>
</FetchHouseKeepingStatisticsResponse>
</soap:Body>
</soap:Envelope>
FetchHouseKeepingStatisticsResponse
<xs:element name="FetchHouseKeepingStatisticsResponse">
<xs:complexType>
<xs:annotation>
<xs:appinfo>
<keepNamespaceDeclarations>xsn</keepNamespaceDeclarations>
</xs:appinfo>
</xs:annotation>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="1" name="Result" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:ResultStatus" />
<xs:element minOccurs="0" maxOccurs="1" name="HouseKeepingStatisticsList" xmlns:q2="http://webservices.micros.com/og/4.3/HouseKeeping/" type="q2:ArrayOfHouseKeepingStatistics" />
</xs:sequence>
</xs:complexType>
</xs:element>
|
Name |
Type |
Data Type |
Use |
Comments |
|
Result |
element |
ResultStatus |
optional |
Results of the housekeeping status.
|
|
HouseKeepingStatisticsList |
element |
ArrayOfHouseKeepingStatistics |
optional |
List of the housekeeping statistics. |
The House Status is a survey of all movements for the current date as well as any future date. Information available from includes arrivals, departures, available rooms, housekeeping status, and expected occupancy for the date searched.
Soap Action: http://webservices.micros.com/ows/5.1/HouseKeeping.wsdl#FetchHouseStatus
<?xml version="1.0"
encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<OGHeader soap:mustUnderstand="1" transactionID="000099" timeStamp="2004-03-22T15:25:01.4625000-05:00" xmlns="http://webservices.micros.com/og/4.3/Core/">
<Origin entityID="WEST" systemType="WEB" />
<Destination entityID="WEST" systemType="PMS" />
<Authentication>
<UserCredentials>
<UserName>SAMPLEUSER</UserName>
<UserPassword>SAMPLEPASSWORD</UserPassword>
</UserCredentials>
</Authentication>
</OGHeader>
</soap:Header>
<soap:Body>
<FetchHouseStatusRequest xmlns="http://webservices.micros.com/ows/5.1/HouseKeeping.wsdl">
<hotelReference hotelCode="SEPARA" />
<roomClass>
</roomClass>
<roomType>
</roomType>
<houseStatusDate>2012-09-27T00:00:00.000-04:00</houseStatusDate>
</FetchHouseStatusRequest>
</soap:Body>
</soap:Envelope>
FetchHouseStatusRequest
<xs:element name="FetchHouseStatusRequest">
<xs:complexType>
<xs:annotation>
<xs:appinfo>
<keepNamespaceDeclarations>xsn</keepNamespaceDeclarations>
</xs:appinfo>
</xs:annotation>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="1" name="hotelReference" xmlns:q1="http://webservices.micros.com/og/4.3/HotelCommon/" type="q1:HotelReference" />
<xs:element minOccurs="0" maxOccurs="1" name="roomClass" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="roomType" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="houseStatusDate" type="xs:dateTime" />
<xs:element minOccurs="1" maxOccurs="1" name="houseStatusDateSpecified" type="xs:boolean" />
<xs:element minOccurs="0" maxOccurs="1" name="includeDayUseForMaxOccupied" type="xs:boolean" />
<xs:element minOccurs="1" maxOccurs="1" name="includeDayUseForMaxOccupiedSpecified" type="xs:boolean" />
</xs:sequence>
</xs:complexType>
</xs:element>
|
Name |
Type |
Data Type |
Use |
Comments |
|
hotelReference |
element |
HotelReference |
optional |
The Hotel Reference.
|
|
roomClass |
element |
string |
optional |
The room class.
|
|
roomType |
element |
string |
optional |
The room type.
|
|
houseStatusDate |
element |
dateTime |
optional |
The house status date.
|
|
houseStatusDateSpecified |
element |
boolean |
required |
The house status with the date specified.
|
|
Name |
Type |
Data Type |
Use |
Comments |
|
|
|
|
|
|
|
includeDayUseForMaxOccupied |
element |
boolean |
optional |
Forecasted occupancy, not including out-of-order rooms: (Total Reservations / Inventory Rooms) x 100. The rooms that are considered in this calculation have a Deduct status attached to them, for both Individual and Block Reservations. Plus the Day Use Rooms. Including the Day Use rooms.
|
|
includeDayUseForMaxOccupiedSpecified |
element |
boolean |
required |
For the date specified - Forecasted occupancy, not including out-of-order rooms: (Total Reservations / Inventory Rooms) x 100. The rooms that are considered in this calculation have a Deduct status attached to them, for both Individual and Block Reservations. Includes the Day Use rooms.
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<soap:Header>
<OGHeader soap:mustUnderstand="1" transactionID="000099" timeStamp="2004-03-22T16:25:01.4625-04:00" primaryLangID="E"
xmlns="http://webservices.micros.com/og/4.3/Core/">
<Origin entityID="WEST" systemType="PMS" />
<Destination entityID="WEST" systemType="WEB" />
<Authentication>
<UserCredentials>
<UserName>SAMPLEUSER</UserName>
<UserPassword>SAMPLEPASSWORD</UserPassword>
</UserCredentials>
</Authentication>
</OGHeader>
<wsa:Action>http://webservices.micros.com/ows/5.1/HouseKeeping.wsdl#FetchHouseStatusResponse</wsa:Action>
<wsa:MessageID>urn:uuid:afda0c57-3bc1-457b-aa94-e97fa03b6773</wsa:MessageID>
<wsa:RelatesTo>urn:uuid:f73b983f-7164-46c9-8467-994476376675</wsa:RelatesTo>
<wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>
<wsse:Security>
<wsu:Timestamp wsu:Id="Timestamp-ceed4770-ed2f-42c1-8d99-9a4c11dc0d42">
<wsu:Created>2012-10-01T15:05:02Z</wsu:Created>
<wsu:Expires>2012-10-01T15:10:02Z</wsu:Expires>
</wsu:Timestamp>
</wsse:Security>
</soap:Header>
<soap:Body>
<FetchHouseStatusResponse xmlns:hk="http://webservices.micros.com/og/4.3/HouseKeeping/" xmlns:c="http://webservices.micros.com/og/4.3/Common/" xmlns="http://webservices.micros.com/ows/5.1/HouseKeeping.wsdl">
<result resultStatusFlag="SUCCESS" />
<houseStatusList>
<hk:HouseStatus>
<hk:roomSummaryStatus>
<hk:totalPhysicalRooms>155</hk:totalPhysicalRooms>
<hk:outofOrder>0</hk:outofOrder>
<hk:totalRoomstoSell>155</hk:totalRoomstoSell>
<hk:outofService>0</hk:outofService>
</hk:roomSummaryStatus>
<hk:activityStatus>
<hk:stayoversRoom>1</hk:stayoversRoom>
<hk:stayoversPersons>1</hk:stayoversPersons>
<hk:stayoversVIP>0</hk:stayoversVIP>
<hk:departuresExpectedRoom>1</hk:departuresExpectedRoom>
<hk:departuresExpectedPersons>1</hk:departuresExpectedPersons>
<hk:departuresExpectedVIP>0</hk:departuresExpectedVIP>
<hk:departuresActualRoom>0</hk:departuresActualRoom>
<hk:departuresActualPersons>0</hk:departuresActualPersons>
<hk:departuresActualVIP>0</hk:departuresActualVIP>
<hk:arrivalsExpectedRoom>5</hk:arrivalsExpectedRoom>
<hk:arrivalsExpectedPersons>5</hk:arrivalsExpectedPersons>
<hk:arrivalsExpectedVIP>2</hk:arrivalsExpectedVIP>
<hk:arrivalsActualRoom>1</hk:arrivalsActualRoom>
<hk:arrivalsActualPersons>1</hk:arrivalsActualPersons>
<hk:arrivalsActualVIP>0</hk:arrivalsActualVIP>
<hk:extendedStaysRoom>0</hk:extendedStaysRoom>
<hk:extendedStaysPersons>0</hk:extendedStaysPersons>
<hk:extendedStaysVIP>0</hk:extendedStaysVIP>
<hk:earlyDeparturesRoom>0</hk:earlyDeparturesRoom>
<hk:earlyDeparturesPersons>0</hk:earlyDeparturesPersons>
<hk:earlyDeparturesVIP>0</hk:earlyDeparturesVIP>
<hk:dayUseRoomsRoom>0</hk:dayUseRoomsRoom>
<hk:dayUseRoomsPersons>0</hk:dayUseRoomsPersons>
<hk:dayUseRoomsVIP>0</hk:dayUseRoomsVIP>
<hk:walkInsRoom>0</hk:walkInsRoom>
<hk:walkInsPersons>0</hk:walkInsPersons>
<hk:walkInsVIP>0</hk:walkInsVIP>
<hk:dayofArrivalCancelsRoom>0</hk:dayofArrivalCancelsRoom>
<hk:dayofArrivalCancelsPersons>0</hk:dayofArrivalCancelsPersons>
<hk:dayofArrivalCancelsVIP>0</hk:dayofArrivalCancelsVIP>
</hk:activityStatus>
<hk:complimentaryStatus>
<hk:complimentaryArrivalsRoom>0</hk:complimentaryArrivalsRoom>
<hk:complimentaryArrivalsPersons>0</hk:complimentaryArrivalsPersons>
<hk:complimentaryArrivalsVIP>0</hk:complimentaryArrivalsVIP>
<hk:complimentarystayOversRoom>0</hk:complimentarystayOversRoom>
<hk:complimentarystayOversPersons>0</hk:complimentarystayOversPersons>
<hk:complimentarystayOversVIP>0</hk:complimentarystayOversVIP>
<hk:complimentarydeparturesRoom>0</hk:complimentarydeparturesRoom>
<hk:complimentarydeparturesPersons>0</hk:complimentarydeparturesPersons>
<hk:complimentarydeparturesVIP>0</hk:complimentarydeparturesVIP>
</hk:complimentaryStatus>
<hk:houseUseStatus>
<hk:houseUseArrivalsRoom>0</hk:houseUseArrivalsRoom>
<hk:houseUseArrivalsPersons>0</hk:houseUseArrivalsPersons>
<hk:houseUseArrivalsVIP>0</hk:houseUseArrivalsVIP>
<hk:houseUsestayoversRoom>0</hk:houseUsestayoversRoom>
<hk:houseUsestayoversPersons>0</hk:houseUsestayoversPersons>
<hk:houseUsestayoversVIP>0</hk:houseUsestayoversVIP>
<hk:houseUsedeparturesRoom>0</hk:houseUsedeparturesRoom>
<hk:houseUsedeparturesPersons>0</hk:houseUsedeparturesPersons>
<hk:houseUsedeparturesVIP>0</hk:houseUsedeparturesVIP>
</hk:houseUseStatus>
<hk:endOfDayProjectionStatus>
<hk:minAvailableTonight>148</hk:minAvailableTonight>
<hk:maxOccupiedTonightRoom>7</hk:maxOccupiedTonightRoom>
<hk:maxOccupiedTonightPersons>7</hk:maxOccupiedTonightPersons>
<hk:maxOccupiedTonightVIP>2</hk:maxOccupiedTonightVIP>
<hk:maxPertOccupiedTonight>4.52</hk:maxPertOccupiedTonight>
<hk:blocksnotPickedUp>0</hk:blocksnotPickedUp>
<hk:individualsRoom>7</hk:individualsRoom>
<hk:individualsPersons>7</hk:individualsPersons>
<hk:individualsVIP>2</hk:individualsVIP>
<hk:groupsandBlocksRoom>0</hk:groupsandBlocksRoom>
<hk:groupsandBlocksPersons>0</hk:groupsandBlocksPersons>
<hk:groupsandBlocksVIP>0</hk:groupsandBlocksVIP>
<hk:roomRevenue>1601</hk:roomRevenue>
</hk:endOfDayProjectionStatus>
<hk:houseRoomStatus />
<hk:turnDownStatus />
</hk:HouseStatus>
</houseStatusList>
</FetchHouseStatusResponse>
</soap:Body>
</soap:Envelope>
FetchHouseStatusResponse
<xs:element name="FetchHouseStatusResponse">
<xs:complexType>
<xs:annotation>
<xs:appinfo>
<keepNamespaceDeclarations>xsn</keepNamespaceDeclarations>
</xs:appinfo>
</xs:annotation>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="1" name="result" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:ResultStatus" />
<xs:element minOccurs="0" maxOccurs="1" name="houseStatusList" xmlns:q2="http://webservices.micros.com/og/4.3/HouseKeeping/" type="q2:ArrayOfHouseStatus" />
</xs:sequence>
</xs:complexType>
</xs:element>
|
Name |
Type |
Data Type |
Use |
Comments |
|
result |
element |
ResultStatus |
optional |
The result.
|
|
houseStatusList |
element |
ArrayOfHouseStatus |
optional |
List of the status of the hotel rooms. |
Updates the HouseKeeping Discrepancies with actual status.
Soap Action: http://webservices.micros.com/ows/5.1/HouseKeeping.wsdl#UpdateHouseKeepingDiscrepancies
<?xml version="1.0"
encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<OGHeader soap:mustUnderstand="1" transactionID="000099" timeStamp="2004-03-22T15:25:01.4625000-05:00" xmlns="http://webservices.micros.com/og/4.3/Core/">
<Origin entityID="WEST" systemType="WEB" />
<Destination entityID="WEST" systemType="PMS" />
<Authentication>
<UserCredentials>
<UserName>SAMPLEUSER</UserName>
<UserPassword>SAMPLEPASSWORD</UserPassword>
</UserCredentials>
</Authentication>
</OGHeader>
</soap:Header>
<soap:Body>
<UpdateHouseKeepingDiscrepanciesRequest xmlns="http://webservices.micros.com/ows/5.1/HouseKeeping.wsdl">
<hotelReference hotelCode="SEPARA" />
<houseKeepingDiscrepancy>
<roomNumber xmlns="http://webservices.micros.com/og/4.3/HouseKeeping/">0101</roomNumber>
<roomStatus xmlns="http://webservices.micros.com/og/4.3/HouseKeeping/">DIRTY</roomStatus>
<hKStatus xmlns="http://webservices.micros.com/og/4.3/HouseKeeping/">VACANT</hKStatus>
<hKPersons xmlns="http://webservices.micros.com/og/4.3/HouseKeeping/">4</hKPersons>
</houseKeepingDiscrepancy>
</UpdateHouseKeepingDiscrepanciesRequest>
</soap:Body>
</soap:Envelope>
UpdateHouseKeepingDiscrepanciesRequest
<xs:element name="UpdateHouseKeepingDiscrepanciesRequest">
<xs:complexType>
<xs:annotation>
<xs:appinfo>
<keepNamespaceDeclarations>xsn</keepNamespaceDeclarations>
</xs:appinfo>
</xs:annotation>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="1" name="hotelReference" xmlns:q1="http://webservices.micros.com/og/4.3/HotelCommon/" type="q1:HotelReference" />
<xs:element minOccurs="0" maxOccurs="1" name="houseKeepingDiscrepancy" xmlns:q2="http://webservices.micros.com/og/4.3/HouseKeeping/" type="q2:HouseKeepingDiscrepancy" />
</xs:sequence>
</xs:complexType>
</xs:element>
|
Name |
Type |
Data Type |
Use |
Comments |
|
hotelReference |
element |
HotelReference |
optional |
The hotel reference.
|
|
houseKeepingDiscrepancy |
element |
HouseKeepingDiscrepancy |
optional |
The housekeeping discrepancy. The status that is different than the Front Office status. |
<?xml version="1.0"
encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<soap:Header>
<OGHeader soap:mustUnderstand="1" transactionID="000099" timeStamp="2004-03-22T16:25:01.4625-04:00" primaryLangID="E"
xmlns="http://webservices.micros.com/og/4.3/Core/">
<Origin entityID="WEST" systemType="PMS" />
<Destination entityID="WEST" systemType="WEB" />
<Authentication>
<UserCredentials>
<UserName>SAMPLEUSER</UserName>
<UserPassword>SAMPLEPASSWORD</UserPassword>
</UserCredentials>
</Authentication>
</OGHeader>
<wsa:Action>http://webservices.micros.com/ows/5.1/HouseKeeping.wsdl#UpdateHouseKeepingDiscrepanciesResponse</wsa:Action>
<wsa:MessageID>urn:uuid:02d2ad91-9332-4821-8ea9-c9acc3352819</wsa:MessageID>
<wsa:RelatesTo>urn:uuid:6ecda390-61a9-4b75-81e3-4288e366de22</wsa:RelatesTo>
<wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>
<wsse:Security>
<wsu:Timestamp wsu:Id="Timestamp-cf11632a-d7b5-4c7d-9874-9beba7d5188a">
<wsu:Created>2012-10-01T18:52:00Z</wsu:Created>
<wsu:Expires>2012-10-01T18:57:00Z</wsu:Expires>
</wsu:Timestamp>
</wsse:Security>
</soap:Header>
<soap:Body>
<_x0020_UpdateHouseKeepingDiscrepenciesResponse xmlns:hk="http://webservices.micros.com/og/4.3/HouseKeeping/" xmlns:c="http://webservices.micros.com/og/4.3/Common/" xmlns="http://webservices.micros.com/ows/5.1/HouseKeeping.wsdl">
<result resultStatusFlag="SUCCESS" />
</_x0020_UpdateHouseKeepingDiscrepenciesResponse>
</soap:Body>
</soap:Envelope>
UpdateHouseKeepingDiscrepenciesResponse
<xs:element name="_x0020_UpdateHouseKeepingDiscrepenciesResponse">
<xs:complexType>
<xs:annotation>
<xs:appinfo>
<keepNamespaceDeclarations>xsn</keepNamespaceDeclarations>
</xs:appinfo>
</xs:annotation>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="1" name="result" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:ResultStatus" />
</xs:sequence>
</xs:complexType>
</xs:element>
|
Name |
Type |
Data Type |
Use |
Comments |
|
result |
element |
ResultStatus |
optional |
The result status. |
ActivityStatus
<xs:complexType name="ActivityStatus">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="1" name="stayoversRoom" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="stayoversPersons" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="stayoversVIP" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="departuresExpectedRoom" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="departuresExpectedPersons" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="departuresExpectedVIP" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="departuresActualRoom" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="departuresActualPersons" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="departuresActualVIP" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="arrivalsExpectedRoom" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="arrivalsExpectedPersons" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="arrivalsExpectedVIP" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="arrivalsActualRoom" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="arrivalsActualPersons" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="arrivalsActualVIP" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="extendedStaysRoom" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="extendedStaysPersons" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="extendedStaysVIP" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="earlyDeparturesRoom" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="earlyDeparturesPersons" type="xs:int" />
<xs:element minOccurs="1" maxOccurs="1" name="earlyDeparturesVIP" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="dayUseRoomsRoom" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="dayUseRoomsPersons" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="dayUseRoomsVIP" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="walkInsRoom" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="walkInsPersons" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="walkInsVIP" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="dayofArrivalCancelsRoom" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="dayofArrivalCancelsPersons" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="dayofArrivalCancelsVIP" type="xs:int" />
</xs:sequence>
</xs:complexType>
|
Name |
Type |
Data Type |
Use |
Comments |
|
stayoversRoom |
element |
int |
optional |
Number of stayover rooms. These are rooms with Guests that stayed the previous evening and that are continuing their stay for the present system day (date).
|
|
stayoversPersons |
element |
int |
optional |
Number of stayover guests. These are Guests that stayed the previous evening and that are continuing their stay for the present system day (date).
|
|
stayoversVIP |
element |
int |
optional |
Number of stayover VIP Guests.
|
|
Name |
Type |
Data Type |
Use |
Comments |
|
|
|
|
|
|
|
departuresExpectedRoom |
element |
int |
optional |
Number of rooms associated with a reservation having a reservation status of Due Out. Includes day use reservations. |
|
|
|
|
|
|
|
departuresExpectedPersons |
element |
int |
optional |
Number of persons (Guests) associated with a reservation having a reservation status of Due Out. Includes day use reservations.
|
|
departuresExpectedVIP |
element |
int |
optional |
Number of VIP (Guests) associated with a reservation having a reservation status of Due Out. Includes day use reservations.
|
|
departuresActualRoom |
element |
int |
optional |
Actual room departures.
|
|
departuresActualPersons |
element |
int |
optional |
Actual Guest departures.
|
|
departuresActualVIP |
element |
int |
optional |
Actual VIP Guest departures.
|
|
arrivalsExpectedRoom |
element |
int |
optional |
Number of rooms associated with a reservation having a reservation status of Reserved and an arrival date equal to the selected date. Includes day use reservations. |
|
Name |
Type |
Data Type |
Use |
Comments |
|
|
|
|
|
|
|
arrivalsExpectedPersons |
element |
int |
optional |
Number of persons (Guests) associated with a reservation having a reservation status of Reserved and an arrival date equal to the selected date. Includes day use reservations.
|
|
arrivalsExpectedVIP |
element |
int |
optional |
Number of VIP (Guests) associated with a reservation having a reservation status of Reserved and an arrival date equal to the selected date. Includes day use reservations.
|
|
arrivalsActualRoom |
element |
int |
optional |
Actual room arrivals.
|
|
arrivalsActualPersons |
element |
int |
optional |
Actual person(s) arrivals.
|
|
arrivalsActualVIP |
element |
int |
optional |
Actual VIP arrivals. |
|
Name |
Type |
Data Type |
Use |
Comments |
|
|
|
|
|
|
|
extendedStaysRoom |
element |
int |
optional |
Number of rooms associated with an extended stay reservation. Extended stay reservations are reservations with a Checked In or Walk-In status and with a departure date that was originally equal to the current business date, but which was changed to a future date.
|
|
extendedStaysPersons |
element |
int |
optional |
Number of persons (Guests) associated with an extended stay reservation. Extended stay reservations are reservations with a Checked In or Walk-In status and with a departure date that was originally equal to the current business date, but which was changed to a future date.
|
|
Name |
Type |
Data Type |
Use |
Comments |
|
|
|
|
|
|
|
extendedStaysVIP |
element |
int |
optional |
Number of VIP (Guests) associated with an extended stay reservation. Extended stay reservations are reservations with a Checked In or Walk-In status and with a departure date that was originally equal to the current business date, but which was changed to a future date.
|
|
earlyDeparturesRoom |
element |
int |
optional |
Number of rooms associated with a reservation having a future departure date, who have checked out on the current business date.
|
|
earlyDeparturesPersons |
element |
int |
optional |
Number of persons associated with a reservation having a future departure date, who have checked out on the current business date.
|
|
Name |
Type |
Data Type |
Use |
Comments |
|
|
|
|
|
|
|
earlyDeparturesVIP |
element |
int |
required |
Number of VIP persons associated with a reservation having a future departure date, who have checked out on the current business date.
|
|
dayUseRoomsRoom |
element |
int |
optional |
Number of rooms having an identical arrival and departure date (the selected date).
|
|
dayUseRoomsPersons |
element |
int |
optional |
Number of persons (Guests) having an identical arrival and departure date (the selected date).
|
|
dayUseRoomsVIP |
element |
int |
optional |
Number of VIP rooms having an identical arrival and departure date (the selected date).
|
|
walkInsRoom |
element |
int |
optional |
Number of rooms that checked in on the current business date without a previous reservation (i.e., the check in is carried out at the same time as the reservation). |
|
ame |
Type |
Data Type |
Use |
Comments |
|
|
|
|
|
|
|
walkInsPersons |
element |
int |
optional |
Number of Guests that checked in on the current business date without a previous reservation (i.e., the check in is carried out at the same time as the reservation).
|
|
walkInsVIP |
element |
int |
optional |
Number of VIP Guests that checked in on the current business date without a previous reservation (i.e., the check in is carried out at the same time as the reservation).
|
|
dayofArrivalCancelsRoom |
element |
int |
optional |
Number of rooms associated with the reservation that are cancelled on the arrival date.
|
|
dayofArrivalCancelsPersons |
element |
int |
optional |
Number of persons (Guests) associated with the reservation that are cancelled on the arrival date.
|
|
dayofArrivalCancelsVIP |
element |
int |
optional |
Number of VIP Guests associated with the reservation that are cancelled on the arrival date. |
ArrayOfHouseKeepingDiscrepancy
<xs:complexType name="ArrayOfHouseKeepingDiscrepancy">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="HouseKeepingDiscrepancy" xmlns:q1="http://webservices.micros.com/og/4.3/HouseKeeping/" type="q1:HouseKeepingDiscrepancy" />
</xs:sequence>
</xs:complexType>
|
Name |
Type |
Data Type |
Use |
Comments |
|
HouseKeepingDiscrepancy |
element |
HouseKeepingDiscrepancy |
optional / multiple |
The housekeeping discrepancy. |
ArrayOfHouseKeepingStatistics
<xs:complexType name="ArrayOfHouseKeepingStatistics">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="HouseKeepingStatistics" xmlns:q1="http://webservices.micros.com/og/4.3/HouseKeeping/" type="q1:HouseKeepingStatistics" />
</xs:sequence>
</xs:complexType>
|
Name |
Type |
Data Type |
Use |
Comments |
|
HouseKeepingStatistics |
element |
HouseKeepingStatistics |
optional / multiple |
Housekeeping statistics. |
ArrayOfHouseStatus
<xs:complexType name="ArrayOfHouseStatus">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="HouseStatus" xmlns:q1="http://webservices.micros.com/og/4.3/HouseKeeping/" type="q1:HouseStatus" />
</xs:sequence>
</xs:complexType>
|
Name |
Type |
Data Type |
Use |
Comments |
|
HouseStatus |
element |
HouseStatus |
optional / multiple |
The Hotel status. |
ArrayOfIDPair
<xs:complexType name="ArrayOfIDPair">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="IDPair" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:IDPair" />
</xs:sequence>
</xs:complexType>
|
Name |
Type |
Data Type |
Use |
Comments |
|
IDPair |
element |
IDPair |
optional / multiple |
A collection of ID Pair elements that in this context (and if present at all), must contain only one element. |
ArrayOfText
<xs:complexType name="ArrayOfText">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="TextElement" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:TextList" />
</xs:sequence>
</xs:complexType>
|
Name |
Type |
Data Type |
Use |
Comments |
|
TextElement |
element |
TextList |
optional / multiple |
In this context, this encapsulates text error message string(s). |
ComplimentaryStatus
<xs:complexType name="ComplimentaryStatus">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="1" name="complimentaryArrivalsRoom" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="complimentaryArrivalsPersons" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="complimentaryArrivalsVIP" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="complimentarystayOversRoom" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="complimentarystayOversPersons" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="complimentarystayOversVIP" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="complimentarydeparturesRoom" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="complimentarydeparturesPersons" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="complimentarydeparturesVIP" type="xs:int" />
</xs:sequence>
</xs:complexType>
|
Name |
Type |
Data Type |
Use |
Comments |
|
complimentaryArrivalsRoom |
element |
int |
optional |
Complimentary Room Arrivals.
|
|
complimentaryArrivalsPersons |
element |
int |
optional |
Complimentary People Arrivals.
|
|
complimentaryArrivalsVIP |
element |
int |
optional |
Number of VIP persons (Guests) associated with reservations having a status of Reserved or Checked In, with a rate code marked as Complimentary in the rate code setup, and whose arrival date is equal to the selected search date.
|
|
complimentarystayOversRoom |
element |
int |
optional |
Number of rooms associated with reservations having a status of Checked-In, with a rate code marked as Complimentary in the rate code setup, and whose departure date is after the selected search date.
|
|
complimentarystayOversPersons |
element |
int |
optional |
Number of persons associated with reservations having a status of Checked-In, with a rate code marked as Complimentary in the rate code setup, and whose departure date is after the selected search date. |
|
Name |
Type |
Data Type |
Use |
Comments |
|
|
|
|
|
|
|
complimentarystayOversVIP |
element |
int |
optional |
Number of VIP persons associated with reservations having a status of Checked-In, with a rate code marked as Complimentary in the rate code setup, and whose departure date is after the selected search date.
|
|
complimentarydeparturesRoom |
element |
int |
optional |
Number of rooms associated with reservations having a status of Checked-Out or Due Out and with a rate code marked as Complimentary in the rate code setup. Select the down arrow to display the Reservation Search screen showing Complimentary departure reservations.
|
|
complimentarydeparturesPersons |
element |
int |
optional |
Number of persons associated with reservations having a status of Checked-Out or Due Out and with a rate code marked as Complimentary in the rate code setup. Select the down arrow to display the Reservation Search screen showing Complimentary departure reservations.
|
|
Name |
Type |
Data Type |
Use |
Comments |
|
|
|
|
|
|
|
complimentarydeparturesVIP |
element |
int |
optional |
Number of VIP persons associated with reservations having a status of Checked-Out or Due Out and with a rate code marked as Complimentary in the rate code setup. Select the down arrow to display the Reservation Search screen showing Complimentary departure reservations. |
EndOfDayProjectionStatus
<xs:complexType name="EndOfDayProjectionStatus">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="1" name="minAvailableTonight" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="maxOccupiedTonightRoom" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="maxOccupiedTonightPersons" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="maxOccupiedTonightVIP" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="maxPertOccupiedTonight" type="xs:double" />
<xs:element minOccurs="0" maxOccurs="1" name="maxPertOccupiedTonightDayUse" type="xs:double" />
<xs:element minOccurs="0" maxOccurs="1" name="blocksnotPickedUp" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="individualsRoom" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="individualsPersons" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="individualsVIP" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="groupsandBlocksRoom" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="groupsandBlocksPersons" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="groupsandBlocksVIP" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="roomRevenue" type="xs:double" />
<xs:element minOccurs="0" maxOccurs="1" name="roomRevenueAvg" type="xs:double" />
</xs:sequence>
</xs:complexType>
|
Name |
Type |
Data Type |
Use |
Comments |
|
minAvailableTonight |
element |
int |
optional |
The minimum (rooms) available tonight.
|
|
maxOccupiedTonightRoom |
element |
int |
optional |
Number of all rooms checked in plus number of all rooms which are expected to be checked in. The rooms that are considered in this calculation have a Deduct status attached to them, for both Individual and Block Reservations.
|
|
maxOccupiedTonightPersons |
element |
int |
optional |
Number of all persons (Guests) checked in plus number of all rooms which are expected to be checked in. The rooms that are considered in this calculation have a Deduct status attached to them, for both Individual and Block Reservations.
|
|
Name |
Type |
Data Type |
Use |
Comments |
|
|
|
|
|
|
|
maxOccupiedTonightVIP |
element |
int |
optional |
Number of all VIP persons (Guests) checked in plus number of all rooms which are expected to be checked in. The rooms that are considered in this calculation have a Deduct status attached to them, for both Individual and Block Reservations.
|
|
maxPertOccupiedTonight |
element |
double |
optional |
(Max. percentage) Forecasted occupancy percentage, not including out-of-order rooms: (Total Reservations / Inventory Rooms) x 100. The rooms that are considered in this calculation have a Deduct status attached to them, for both Individual and Block Reservations.
|
|
maxPertOccupiedTonightDayUse |
element |
double |
optional |
Max. percentage day use included with the max. Percentage Occupied Tonight.
|
|
blocksnotPickedUp |
element |
int |
optional |
Total number of rooms that were allotted to blocks and which have not yet been picked up.
|
|
individualsRoom |
element |
int |
optional |
Number of individual rooms.
|
|
Name |
Type |
Data Type |
Use |
Comments |
|
|
|
|
|
|
|
individualsPersons |
element |
int |
optional |
Number of individual persons (Guests).
|
|
individualsVIP |
element |
int |
optional |
Number of VIP Guests.
|
|
groupsandBlocksRoom |
element |
int |
optional |
Number of rooms that are associated with group reservations.
|
|
groupsandBlocksPersons |
element |
int |
optional |
Number of Guests that are associated with group reservations.
|
|
groupsandBlocksVIP |
element |
int |
optional |
Number of VIP Guests that are associated with group reservations.
|
|
roomRevenue |
element |
double |
optional |
The room revenue.
|
|
roomRevenueAvg |
element |
double |
optional |
The room revenue average. |
HotelReference
<xs:complexType name="HotelReference">
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute name="chainCode" type="xs:string" />
<xs:attribute name="hotelCode" type="xs:string" />
</xs:extension>
</xs:simpleContent>
</xs:complexType>
|
Name |
Type |
Data Type |
Use |
Comments |
|
HotelReference |
extension |
string |
|
The hotel reference. |
|
chainCode |
attribute |
string |
none |
The chain code. |
|
hotelCode |
attribute |
string |
none |
The hotel code. |
HouseKeepingDiscrepancy
<xs:complexType name="HouseKeepingDiscrepancy">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="1" name="roomNumber" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="roomType" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="roomStatus" xmlns:q1="http://webservices.micros.com/og/4.3/HouseKeeping/" type="q1:HouseKeepingRoomStatus" />
<xs:element minOccurs="0" maxOccurs="1" name="hKStatus" xmlns:q2="http://webservices.micros.com/og/4.3/HouseKeeping/" type="q2:HouseKeepingFOStatus" />
<xs:element minOccurs="0" maxOccurs="1" name="fOStatus" xmlns:q3="http://webservices.micros.com/og/4.3/HouseKeeping/" type="q3:HouseKeepingFOStatus" />
<xs:element minOccurs="0" maxOccurs="1" name="fOPersons" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="reservationStatus" xmlns:q4="http://webservices.micros.com/og/4.3/HouseKeeping/" type="q4:HouseKeepingReservationStatus" />
<xs:element minOccurs="0" maxOccurs="1" name="hKPersons" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="discrepancy" type="xs:string" />
</xs:sequence>
</xs:complexType>
|
Name |
Type |
Data Type |
Use |
Comments |
|
roomNumber |
element |
string |
optional |
The room number. |
|
roomType |
element |
string |
optional |
The room type. |
|
roomStatus |
element |
HouseKeepingRoomStatus |
optional |
The room status. |
|
hKStatus |
element |
HouseKeepingFOStatus |
optional |
The Housekeeping Front of House Status. |
|
fOStatus |
element |
HouseKeepingFOStatus |
optional |
The Housekeeping Front of House Status. |
|
fOPersons |
element |
string |
optional |
The number of people in the Front of House. |
|
Name |
Type |
Data Type |
Use |
Comments |
|
|
|
|
|
|
|
reservationStatus |
element |
HouseKeepingReservationStatus |
optional |
The Reservation status. |
|
hKPersons |
element |
int |
optional |
The housekeeping status. |
|
discrepancy |
element |
string |
optional |
The Housekeeping (status) Discrepancy. |
HouseKeepingFOStatus
<xs:simpleType name="HouseKeepingFOStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="VACANT" />
<xs:enumeration value="OCCUPIED" />
</xs:restriction>
</xs:simpleType>
|
Name |
Type |
Data Type |
Use |
Comments |
|
HouseKeepingFOStatus |
enumeration |
string |
|
The possible values are VACANT and OCCUPIED. |
HouseKeepingReservationStatus
<xs:simpleType name="HouseKeepingReservationStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="STAYOVER" />
<xs:enumeration value="ARRIVED" />
<xs:enumeration value="DUEOUT" />
<xs:enumeration value="DEPARTURES" />
<xs:enumeration value="DEPARTED" />
<xs:enumeration value="ARRIVAL" />
<xs:enumeration value="EXPECTED" />
<xs:enumeration value="RESERVED" />
<xs:enumeration value="DAYUSE" />
<xs:enumeration value="ARRIVEDANDSTAYOVER" />
<xs:enumeration value="VACANT" />
<xs:enumeration value="NOTRESERVED" />
</xs:restriction>
</xs:simpleType>
|
Name |
Type |
Data Type |
Use |
Comments |
|
HouseKeepingReservationStatus |
enumeration |
string |
|
The possible values are STAYOVER, ARRIVED, DUEOUT, DEPARTURES, DEPARTED, ARRIVAL, EXPECTED, RESERVED, DAYUSE, ARRIVEDANDSTAYOVER, VACANT, and NOTRESERVED. |
HouseKeepingRoomStatus
<xs:simpleType name="HouseKeepingRoomStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="CLEAN" />
<xs:enumeration value="DIRTY" />
<xs:enumeration value="OUTOFORDER" />
<xs:enumeration value="PICKUP" />
<xs:enumeration value="INSPECTED" />
<xs:enumeration value="OUTOFSERVICE" />
</xs:restriction>
</xs:simpleType>
|
Name |
Type |
Data Type |
Use |
Comments |
|
HouseKeepingRoomStatus |
enumeration |
string |
|
The possible values are CLEAN, DIRTY, OUTOFORDER, PICKUP, INSPECTED, and OUTOFSERVICE. |
HouseKeepingStatistics
<xs:complexType name="HouseKeepingStatistics">
<xs:simpleContent>
<xs:extension base="xs:int">
<xs:attribute name="description" type="xs:string" />
</xs:extension>
</xs:simpleContent>
</xs:complexType>
|
Name |
Type |
Data Type |
Use |
Comments |
|
HouseKeepingStatistics |
extension |
int |
|
The housekeeping statistics. |
|
description |
attribute |
string |
none |
The description. |
HouseRoomStatus
<xs:complexType name="HouseRoomStatus">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="1" name="inspectedRoomVacant" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="inspectedRoomOccupied" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="cleanRoomVacant" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="cleanRoomOccupied" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="dirtyRoomVacant" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="dirtyRoomOccupied" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="pickupRoomVacant" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="pickupRoomOccupied" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="outofOrderRoomVacant" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="outofOrderRoomOccupied" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="outofServiceRoomVacant" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="outofServiceRoomOccupied" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="queueRoom" type="xs:int" />
</xs:sequence>
</xs:complexType>
|
Name |
Type |
Data Type |
Use |
Comments |
|
inspectedRoomVacant |
element |
int |
optional |
Indicates if the inspected room is vacant. |
|
inspectedRoomOccupied |
element |
int |
optional |
Indicates if the inspected room is occupied. |
|
cleanRoomVacant |
element |
int |
optional |
Indicates if the clean room is vacant. |
|
cleanRoomOccupied |
element |
int |
optional |
Indicates if the clean room is occupied. |
|
dirtyRoomVacant |
element |
int |
optional |
Indicates if the dirty room is vacant. |
|
dirtyRoomOccupied |
element |
int |
optional |
Indicates if the dirty room is occupied. |
|
pickupRoomVacant |
element |
int |
optional |
Indicates if the vacant room is in pickup status. |
|
pickupRoomOccupied |
element |
int |
optional |
Indicates if the occupied room is in pickup status. |
|
outofOrderRoomVacant |
element |
int |
optional |
Indicates if the vacant room is out of order. |
|
outofOrderRoomOccupied |
element |
int |
optional |
Indicates if the occupied room is out of order. |
|
outofServiceRoomVacant |
element |
int |
optional |
Indicates if the vacant room is out of service. |
|
outofServiceRoomOccupied |
element |
int |
optional |
Indicates if the occupied room is out of service. |
|
queueRoom |
element |
int |
optional |
Indicates if the room is on the queue room list. |
HouseStatus
<xs:complexType name="HouseStatus">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="1" name="roomSummaryStatus" xmlns:q1="http://webservices.micros.com/og/4.3/HouseKeeping/" type="q1:RoomSummaryStatus" />
<xs:element minOccurs="0" maxOccurs="1" name="activityStatus" xmlns:q2="http://webservices.micros.com/og/4.3/HouseKeeping/" type="q2:ActivityStatus" />
<xs:element minOccurs="0" maxOccurs="1" name="complimentaryStatus" xmlns:q3="http://webservices.micros.com/og/4.3/HouseKeeping/" type="q3:ComplimentaryStatus" />
<xs:element minOccurs="0" maxOccurs="1" name="houseUseStatus" xmlns:q4="http://webservices.micros.com/og/4.3/HouseKeeping/" type="q4:HouseUseStatus" />
<xs:element minOccurs="0" maxOccurs="1" name="endOfDayProjectionStatus" xmlns:q5="http://webservices.micros.com/og/4.3/HouseKeeping/" type="q5:EndOfDayProjectionStatus" />
<xs:element minOccurs="0" maxOccurs="1" name="houseRoomStatus" xmlns:q6="http://webservices.micros.com/og/4.3/HouseKeeping/" type="q6:HouseRoomStatus" />
<xs:element minOccurs="0" maxOccurs="1" name="turnDownStatus" xmlns:q7="http://webservices.micros.com/og/4.3/HouseKeeping/" type="q7:TurnDownStatus" />
</xs:sequence>
</xs:complexType>
|
Name |
Type |
Data Type |
Use |
Comments |
|
roomSummaryStatus |
element |
RoomSummaryStatus |
optional |
The room summary status. |
|
activityStatus |
element |
ActivityStatus |
optional |
The Activity status. |
|
complimentaryStatus |
element |
ComplimentaryStatus |
optional |
The complimentary status. |
|
houseUseStatus |
element |
HouseUseStatus |
optional |
The house use status. |
|
endOfDayProjectionStatus |
element |
EndOfDayProjectionStatus |
optional |
The end of day projection status. |
|
houseRoomStatus |
element |
HouseRoomStatus |
optional |
In the hotel room status. |
|
turnDownStatus |
element |
TurnDownStatus |
optional |
The turn down status. |
HouseUseStatus
<xs:complexType
name="HouseUseStatus">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="1" name="houseUseArrivalsRoom" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="houseUseArrivalsPersons" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="houseUseArrivalsVIP" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="houseUsestayoversRoom" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="houseUsestayoversPersons" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="houseUsestayoversVIP" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="houseUsedeparturesRoom" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="houseUsedeparturesPersons" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="houseUsedeparturesVIP" type="xs:int" />
</xs:sequence>
</xs:complexType>
|
Name |
Type |
Data Type |
Use |
Comments |
|
houseUseArrivalsRoom |
element |
int |
optional |
The house use arrivals room. |
|
houseUseArrivalsPersons |
element |
int |
optional |
The house use people arrivals. |
|
houseUseArrivalsVIP |
element |
int |
optional |
The house use Arrivals VIP. |
|
houseUsestayoversRoom |
element |
int |
optional |
The house use stayovers room. |
|
houseUsestayoversPersons |
element |
int |
optional |
The house use stayovers persons. |
|
houseUsestayoversVIP |
element |
int |
optional |
The house use stayovers VIP. |
|
houseUsedeparturesRoom |
element |
int |
optional |
The house use departures room. |
|
houseUsedeparturesPersons |
element |
int |
optional |
The house use departures persons. |
|
houseUsedeparturesVIP |
element |
int |
optional |
The house use departures VIP. |
IDPair
<xs:complexType name="IDPair">
<xs:attribute name="idType" type="xs:string" />
<xs:attribute name="operaId" type="xs:long" />
<xs:attribute name="externalId" type="xs:string" />
</xs:complexType>
|
Name |
Type |
Data Type |
Use |
Comments |
|
idType |
attribute |
string |
none |
In this context and if transaction is successful, this is hard-coded to RESERVATION. |
|
operaId |
attribute |
long |
none |
The confirmation number assigned to this booking. |
|
externalId |
attribute |
string |
none |
The external id. |
<xs:complexType name="ResultStatus">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="1" name="Text" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:TextList" />
<xs:element minOccurs="0" maxOccurs="1" name="IDs" xmlns:q2="http://webservices.micros.com/og/4.3/Common/" type="q2: IDPairList" />
<xs:element minOccurs="0" maxOccurs="1" name="OperaErrorCode" type="xs:string" />
</xs:sequence>
<xs:attribute name="resultStatusFlag" xmlns:q3="http://webservices.micros.com/og/4.3/Common/" type="q3:ResultStatusFlag" />
</xs:complexType>
|
Name |
Type |
Data Type |
Use |
Comments |
|
resultStatusFlag |
attribute |
ResultStatusFlag |
none |
The primary indication of the success or failure of the called function. |
|
Text |
element |
TextList |
optional |
Used to store any error or warning text associated with the transaction. |
|
IDs |
element |
IDPairList |
optional |
If populated, this contains the ReservationID of the newly created booking. |
|
OperaErrorCode |
element |
string |
optional |
The error code returned in the response whenever there is an error returned from the OPERA database. All error codes are defined in the default "FIDELIO" channel under the Error tab. |
ResultStatusFlag
<xs:simpleType name="ResultStatusFlag">
<xs:restriction base="xs:string">
<xs:enumeration value="FAIL" />
<xs:enumeration value="SUCCESS" />
</xs:restriction>
</xs:simpleType>
|
Name |
Type |
Data Type |
Use |
Comments |
|
ResultStatusFlag |
enumeration |
string |
|
The possible values are FAIL and SUCCESS. |
RoomSummaryStatus
<xs:complexType name="RoomSummaryStatus">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="1" name="totalPhysicalRooms" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="outofOrder" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="totalRoomstoSell" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="outofService" type="xs:int" />
</xs:sequence>
</xs:complexType>
|
Name |
Type |
Data Type |
Use |
Comments |
|
totalPhysicalRooms |
element |
int |
optional |
The total physical rooms. |
|
outofOrder |
element |
int |
optional |
The out of order rooms. |
|
totalRoomstoSell |
element |
int |
optional |
Total rooms to sell. |
|
outofService |
element |
int |
optional |
The out of service rooms. |
Text
<xs:complexType name="Text">
<xs:simpleContent>
<xs:extension base="xs:normalizedString">
<xs:attribute name="formatted" type="xs:boolean" />
<xs:attribute name="language" type="xs:language" />
</xs:extension>
</xs:simpleContent>
</xs:complexType>
|
Name |
Type |
Data Type |
Use |
Comments |
|
Text |
extension |
normalizedString |
|
The associated text. |
|
formatted |
attribute |
boolean |
none |
The format. |
|
language |
attribute |
language |
none |
The language code. |
<xs:complexType name="TextList">
<xs:sequence>
<xs:element name="TextElement" type="tns:Text" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
|
Name |
Type |
Data Type |
Use |
Comments |
|
TextList |
extension |
Text |
|
The text element. |
TurnDownStatus
<xs:complexType name="TurnDownStatus">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="1" name="turnDownRequired" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="turnDownNotRequired" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="turnDownCompleted" type="xs:int" />
</xs:sequence>
</xs:complexType>
|
Name |
Type |
Data Type |
Use |
Comments |
|
turnDownRequired |
element |
int |
optional |
Status Turn down required. |
|
turnDownNotRequired |
element |
int |
optional |
Status Turn down not required. |
|
turnDownCompleted |
element |
int |
optional |
Status Turn down completed. |